home *** CD-ROM | disk | FTP | other *** search
/ Cobra Utilities for Doom & Doom II / Cobra Utilities For Doom & Doom II - Disc 2.iso / files / program / easyw105 / easywad.doc < prev    next >
Encoding:
Text File  |  1994-09-08  |  14.9 KB  |  361 lines
  1. DOOM EasyWAD v1.05 by M. van der Heide of ThunderWare Research Center
  2. Release date: September 9, 1994
  3.  
  4. This program was made for all those DOOMers with loadsa WAD files. It 
  5. produces a nice WAD selection interface, which should put an end to losing
  6. track of all these files. (At least I get more frustrated from finding that
  7. particular WAD file and typing all that things on the command line than from
  8. playing DOOM itself!).
  9.  
  10.  
  11.  
  12. HERE'S WHAT TO DO:
  13.  
  14.   You may unpack this program in any directory you like.
  15.   You will first have to edit your configuration file: "EASYWAD.CFG".
  16.   Separation between words is very simple: use a space, a tab or a newline.
  17.   Empty lines are ignored; comment can be inserted by preceding it with a '#'
  18.   character.
  19.   The following keywords are available:
  20.  
  21.   - DOOMDIR      should be followed by the directory name of the DOOM program
  22.                  files. The default is the current directory;
  23.   - DOOMVERSION  is followed by the DOOM version number (currently 1.0, 1.1,
  24.                  1.2, 1.4, 1.5, 1.6 and 1.666 are available)
  25.                  This directly determines the available options. The default
  26.                  version number is 1.0;
  27.   - WADDIR       After this come all your directories that contain WAD files.
  28.                  Any directory can be included, when needed preceded by a
  29.                  drive:. The maximum number of directories is 400. A
  30.                  directory "." means the current directory on that drive.
  31.                  After any directory name may come an entry "-S" (or "/S"),
  32.                  which means: handle all its subdirectories as well. If no
  33.                  "WADDIR" is found, then the DOOM directory is used.
  34.   - WADINFOFILE  is followed by a filename. The purpose of this filename is
  35.                  explaned later in this document. If it is not found, then the
  36.                  used filename will be "WADS.DSC" in the current directory.
  37.   - SETSKILL     is used to change the default difficulty level. It is 
  38.                  followed by the skill level (1 = Pathetic, 5 = Megacool)
  39.   - NOSEARCH     may be included to speed things up. The exact purpose is
  40.                  explaned in the "THE WADINFOFILE" section.
  41.   - DEATHMATCH   just selects deathmatch as default.
  42.   - AUTOINCLUDE  is used to auto-select files that you always want to have 
  43.                  added. The maximum is 5 files. Any (partial) path should
  44.                  also be found in the "WADDIR" series.
  45.   - SETPLAYTYPE  must be followed by one of the fixed words
  46.                  "ALONE", for one player;
  47.                  "IPX", for IPX compatible multiplayer;
  48.                  "NULL", for null-modem dualplayer;
  49.   - SETCOMPORT   takes one parameter: the COM port number (1-4), which is used
  50.                  when you choose to play with a null-modem link;
  51.   - SETNODES     takes one parameter: the number of players (2-4), which is
  52.                  used when you choose to play with an IPX compatible link;
  53.   - ADDSWITCHES  After the keyword should all the other DOOM switches be
  54.                  given, that are not handled from within EASYWAD. Currently
  55.                  available switches are:
  56.                  (1.2+) -NOMONSTERS, -RESPAWN, -NOJOY, -NOMOUSE, -NOMUSIC
  57.                         -NOSFX, -NOSOUND;
  58.                  (1.5+) -ALTDEATH, -FAST.
  59.                  Those switches are passed directly to DOOM.
  60.   - SORTFILES    must be followed by one of the fixed words
  61.                  "NAME", to sort all WAD files by name;
  62.                  "INFO", to sort all WAD files by their info field.
  63.  
  64.   Note that you need the right DOOM version for the right switch. For example
  65.   DEATHMATCH can not be choosen if you have DOOM v1.0 or v1.1, as this option
  66.   was not yet implemented by that time.
  67.  
  68.  
  69.  
  70. LET'S GET STARTED:
  71.  
  72.   Start the wadmenu with the command "EW".
  73.   You will seen a screen with the following items:
  74.  
  75.   - The episodes;
  76.   - The skills;
  77.   - The playtypes;
  78.   - The starting level;
  79.   - A DEATHMATCH item;
  80.   - Loadsa WAD files with an info field!;
  81.   - 2 pagers ("<<<" and ">>>");
  82.   - A [START] item;
  83.   - A [READ PREVIOUS] item;
  84.   - An [AUTO] item;
  85.   - A mouse pointer if a mouse was found :)
  86.  
  87.   When you move the mouse, each line can be highlited. Use the left mouse
  88.   button to select each field. You can select as many WAD files as you like.
  89.   Just click again on a WAD file to de-select it. If you have more than 60
  90.   WAD files, then use the pagers to see the next/previous page.
  91.   You can quit directly by pressing the right mouse button or the [ESC] key.
  92.   Notice that the files you typed in the configuration file after the keyword
  93.   "AUTOINCLUDE" are already selected.
  94.  
  95.   [START]          When you're done clicking, punch the left mouse button on
  96.                    this field and play the selected DOOM part. What happened
  97.                    is that the program made a batch file "START.BAT", which is
  98.                    automatically started. This is useful (Yep, really!). If
  99.                    you finished playing, but want to play the same thing again,
  100.                    just type "START"  at the command line in stead of "EW".
  101.   [READ PREVIOUS]  does the opposite. It reads the file "START.BAT" back and
  102.                    sets all values accordingly. All files are automatically
  103.                    selected.
  104.   [AUTO]           automatically selects the correct episode and level to
  105.                    start, according to the selected WAD files. This option
  106.                    does not start the game, you still have to hit [START].
  107.  
  108.   Keyboard equivalents:
  109.  
  110.   'E'          Change (E)pisode;
  111.   'L'          Change (L)evel;
  112.   'S'          Change (S)kill;
  113.   'T'          Change play(T)ype;
  114.                if playtype is 'IPX compatible':
  115.                  'N' Change (N)umber of players;
  116.                if playtype is 'Null-modem link':
  117.                  'C' Change (C)OM port number;
  118.   'D'          Toggle (D)eathmatch;
  119.   'A'          Activate [AUTO] item;
  120.   'R'          Activate [READ PREVIOUS] item;
  121.   [ENTER]      Start game;
  122.   [PAGE DOWN]  Next page of WAD files;
  123.   [PAGE UP]    Previous page of WAD files;
  124.   [ESC]        Abort EASYWAD.
  125.  
  126.   if no mouse was found, then select WAD files with the keys
  127.  
  128.   [CURS UP]    (Wraps to bottom)
  129.   [CURS DOWN]  (Wraps to top)
  130.   [CURS LEFT]  (Wraps to far right)
  131.   [CURS RIGHT] (Wraps to far left)
  132.   [SPACE]      (Un)select pointed WAD file
  133.  
  134.  
  135.  
  136. THE INFOFIELD
  137.  
  138.   After a WAD file name comes the infofield. The first part is the episodes
  139.   and levels that are patched by this file; for example:
  140.   E1M1 means: first episode (E1), first level (M1). The convention is:
  141.  
  142.   Ex-    means: the entire episode x, including the secret level;
  143.   ExMy-z means: Episode x, levels y through z;
  144.   ExMy,z means: Episode x, levels y and z;
  145.  
  146.   After this come the other patched parts:
  147.  
  148.   "c" = new (C)olors (palette change);
  149.   "d" = new (D)emos;
  150.   "s" = new (S)ound effects;
  151.   "m" = new (M)usic;
  152.   "p" = new s(P)rites;
  153.   "g" = new (G)raphics.
  154.  
  155.   If a WAD file patches only one part, then the complete name is printed. For
  156.   example, a file that only contains new music will have a field "music", etc.
  157.  
  158.  
  159.  
  160. THE WADINFOFILE
  161.  
  162.   This file contains all the above information. Each file is seperated into
  163.   four fields: drivenumber directory filename info
  164.   The info field contains the exact info as on the screen. This field can be
  165.   edited with any ASCII editor. If it exceeds 16 characters, then the rest is
  166.   cut off. You could add a mark for how much you like this WAD, or a sign that
  167.   says especially cool on DEATHMATCH, or anything else; just no longer than 16
  168.   characters.
  169.   The file is created when it did not exist at startup, or when you run
  170.   "EW -R" (or "EASYWAD -R", after which you should run "START" yourself :)
  171.   Unfortunately this does also overwrite your additional info.
  172.  
  173.   The option "NOSEARCH" should be used with some caution. Usually, EASYWAD
  174.   will search all given WADDIR directories for WAD files (and write a
  175.   WADINFOFILE if needed). "NOSEARCH" forces the program to NOT search the
  176.   directories, but to use the WADINFOFILE directly to obtain all WAD file
  177.   statistics. This REALLY speeds up things when using LOADS of WAD files or
  178.   WAD files on cd-rom. The problem comes if you add or delete a WAD file (or
  179.   even a WAD directory). As no directories are scanned, the program will be
  180.   unable to notice the changes, and still display the 'old' list. So, if you
  181.   use this option and change ANYTHING in your filesystem, be sure to use
  182.   "EW -R" (or "EASYWAD -R") to update the WADINFOFILE!
  183.  
  184.  
  185.  
  186. NOTE TO THOSE WHO ARE UPGRADING FROM VERSION 1.02:
  187.  
  188.   People who are upgrading from version or 1.02 are requested to start
  189.   EASYWAD the first time with "EW -R" (or "EASYWAD -R"), as the WADINFOFILE
  190.   has undergone several major changes.
  191.  
  192.  
  193.  
  194. LIMITS:
  195.  
  196.   The program can handle a maximum of 1000 WAD files. 60 files are printed in
  197.   a page on the selection screen. Just click on a 'pager' and the next page is
  198.   displayed.
  199.  
  200.  
  201.  
  202. CONSIDERATIONS:
  203.  
  204.   Remember that all the things you selected are put on one command line
  205.   (in "START.BAT") One line should not exceed 128 characters, for COMMAND.COM
  206.   (your command prompter) to be able to read it completely. (This problem has
  207.   been solved in version 1.5 of DOOM.
  208.   The message: keep your path(name)s as short as  possible! A good trick is:
  209.   If you have wadfiles on a different drive, then first change the current
  210.   directory of that drive to the WADs directory and use an entry "drive:." as a
  211.   "WADDIR" entry.
  212.   For example: the DOOM drive is C: and you also have extra WAD files on D: in
  213.   the directory "\DOOM\WADS".
  214.   Then you should edit "EW.BAT" to start with the command "CD D:\DOOM\WADS"
  215.   and edit "EASYWAD.CFG" to hold "WADDIR D:."
  216.  
  217.   Notice that you do not have to 'Press return to continue' when you start
  218.   DOOM with a selected WAD file.
  219.  
  220.  
  221. Good luck!
  222.  
  223. If you use this program, please drop a note (you like it, you hate it, you
  224. would like things changed) at the following email address:
  225.  
  226. martijn@.htsa.hva.nl
  227.  
  228.  
  229.  
  230. COPYRIGHTS:
  231.  
  232.   This program has no copyrights whatsoever.
  233.   If it causes any problems ... yeah, right!
  234.   This absolutely freeware program may be edited and distributed at taste.
  235.   The only thing that I ask is to distribute the complete package.
  236.  
  237.  
  238.  
  239. CREDITS GO TO:
  240.  
  241.   - The makers of DOOM (Id Software). They changed my life completely.
  242.   - The makers of DMSPEC12.TXT (Matt Fell & Hank Leukart). This is where I
  243.     found the info on the structure of a WAD file;
  244.   - The makers of DEU (Doom Editor Utility, by Brendon Wyber & Raphael Quinet)
  245.     for their commented source. I use a few of their namings in my source.
  246.     (defines THING_..., fieldnames in structures).
  247.  
  248.  
  249.  
  250. ADDITIONAL CREDITS GO TO:
  251.  
  252.   - J.J. Kwast of ThunderWare Research Center. He gave me the constructive
  253.     criticism I needed when he wasn't DEU-ing.
  254.   - B. Castricum for 'play-testing' and giving additional comments.
  255.   - All those people out there that are constantly creating new WAD files.
  256.  
  257.  
  258.  
  259. CHANGES SINCE VERSION 1.03 (release September 5, 1994):
  260.  
  261.   - Added "ADDSWITCHES" to allow direct passing of un-covered DOOM switches;
  262.   - Added "SORTFILES" to allow for file sorting before displaying;
  263.   - Added several DOOM version checks;
  264.   - Changed all display and field-handling routines. Fields are no longer
  265.     printed if the DOOM version is too low;
  266.   - Added WAD-file directory identifiers "INFOPACK" and "PLATFORM", which I
  267.     found in a lot of WADfiles. They were previously treated as New Graphics
  268.     (Those identifiers are NOT from Id SoftWare!)
  269.   - Shorted some code, as I got the funny message 'Out of near heap space'
  270.     while compiling ...
  271.  
  272.  
  273.  
  274. CHANGES SINCE VERSION 1.02 (release August 25, 1994):
  275.  
  276.   - Changed program location: EASYWAD is no longer forced to be in your DOOM
  277.     directory;
  278.   - Added "DOOMDIR" in configfile to allow for this change;
  279.   - Added new scanning routine for the configfile to allow comment lines;
  280.   - Added keyboard equivalents for all selection types. This also means that
  281.     a mouse is longer needed;
  282.   - Removed the bug from EW.BAT that created 'Syntax error';
  283.   - Added support for higher versions of DOOM. The most important change is
  284.     that you can now select more WAD files, as since version 1.5 of DOOM you
  285.     are allowed to make a file from the command line options;
  286.   - Added "DOOMVERSION" in configfile to allow for this change;
  287.   - Erased "Modem setup" from playtype field on screen, as this would take
  288.     far too much administration. sorry :)
  289.   - Added "SETPLAYTYPE" in configfile to change the default playtype;
  290.   - Added "SETNODES" in configfile to set the default number of players in a
  291.     multiplayer IPX game;
  292.   - Added "SETCOMPORT" in configfile to set the default COM port when using
  293.     the null-modem link game;
  294.   - Added "Number of players"/"COM port" on screen;
  295.   - When you moved the mouse too quikly, some hi-lighted items kept being
  296.     hi-lighted. Fixed;
  297.   - Completely changed layout of this DOC file.
  298.  
  299.  
  300.  
  301. CHANGES SINCE VERSION 1.01 (release August 4, 1994):
  302.  
  303.   - Added [AUTO] field;
  304.   - Added ability to scan for possible shorter paths to WAD files;
  305.   - Added "AUTOINCLUDE" in configfile;
  306.   - Added "NOSEARCH" in configfile;
  307.   - Added routines, defines and structures to be able to read info on a WAD
  308.     file directly from the file itself;
  309.   - Changed maximum of WADfiles on screen from 100 to 60 to allow for a longer
  310.     info fields (from 10 to 16 chars);
  311.   - Added item "-S" in "WADDIR" field to allow for handling subdirectories;
  312.   - Added switch "-R" on the command line to Rescan all "WADDIR" items;
  313.   - Added switch "+file" on the command line to allow for different config
  314.     files;
  315.   - Changed "EW.BAT" for the new switches;
  316.   - Added keyboard check for 'escape': abort;
  317.   - Partial rewrite of the code, to gain some speed;
  318.   - Added some checks to prevent the code from hanging the system :)
  319.  
  320.  
  321.  
  322. CHANGES SINCE VERSION 1.00 (internal release July 17, 1994):
  323.  
  324.   - A few bugfixes :)
  325.   - Added [READ PREVIOUS] field;
  326.   - Added [START] field;
  327.     - Start game is now done by clicking [START] i.s.o. the right mouse button;
  328.     - Changed meaning of right mouse button to: abort;
  329.   - Added "SETSKILL" in configfile;
  330.   - Added "DEATHMATCH" in configfile;
  331.   - Changed location of 'program name' on screen to the top;
  332.  
  333.  
  334.  
  335. CONTENTS OF THE EASYWAD PACKAGE
  336.  
  337. This package should contain the following files:
  338.  
  339.   EASYWAD.DOC - Guess what? You're reading it!
  340.   EASYWAD.EXE - The main thing
  341.   EASYWAD.CFG - An example configuration file
  342.   EW.BAT      - The usual entrance :)
  343.   EASYWAD.C   - The source code of this utility
  344.  
  345. If any part is missing, please contact me at the above address to receive the
  346. full copy.
  347.  
  348.  
  349.  
  350. WHAT YOU NEED:
  351.  
  352.   The same stuff as for DOOM:
  353.  
  354.   - A PC (minumum is a '386 for DOOM and a '286 for this proggie);
  355.   - A VGA screen;
  356.  
  357.   Extra:
  358.  
  359.   - An initialized mouse (recommended);
  360.   - A few spare sectors on your harddisk.
  361.